GxClientFilterModel

```
public interface GxClientFilterModel
```
When saving or restoring state on a filter the filter model is used. The filter model represents the state of the filter

See Also:
[]

Method Summary

Methods
Modifier and Type	Method and Description
`BBjString`	`apply(BBjNumber send!)` Apply the filter This method will only compose the model and send it to the client in case `send!` is true. On the client the new model will be displayed on the filter panel but it will not be applied on the data. To execute the model on the client you need to call `execute(1)`
`BBjString`	`apply()` Apply the filter This method only compose the model and send it to the client On the client the new model will be displayed on the filter panel but it will not be applied on the data. To execute the model on the client you need to call `execute(1)`
`void`	`clearFilter()` Clear the filter
`BBjString`	`execute(BBjNumber send!)` Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set.
`BBjString`	`execute()` Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set.
`JsonObject`	`getAsJsonObject()` Convert the model to JSON object
`BBjString`	`getColumn()` Get the working column
`BBjGridExWidget`	`getWidget()` Get the widget instance
`BBjNumber`	`isFilterActive()` Check if the filter is action or not #API
`void`	`setColumn(BBjString column!)` Set the working column
`void`	`setWidget(BBjGridExWidget widget!)` Set the widget instance
`BBjNumber`	`supportsCombinedModel()` Check if the filter supported the combined model
`BBjString`	`update()` Update the filter on the client and execute it.

- Method Detail
  - apply
```
public BBjString apply(BBjNumber send!)
```
    Apply the filter
    
    This method will only compose the model and send it to the client in case send! is true. On the client the new model will be displayed on the filter panel but it will not be applied on the data. To execute the model on the client you need to call execute(1)
    
    Parameters:
    BBjNumber send! when true the model will be send to the client , false otherwise
    Returns:
    BBjString The generated js code used to apply the model
    Throws:
    256 when the column or the widget are not defined
    See Also:
    GxClientFilterModel.execute()
  - apply
```
public BBjString apply()
```
    Apply the filter
    
    This method only compose the model and send it to the client On the client the new model will be displayed on the filter panel but it will not be applied on the data. To execute the model on the client you need to call execute(1)
    
    Returns:
    BBjString The generated js code used to apply the model
    Throws:
    256 when the column or the widget are not defined
    See Also:
    GxClientFilterModel.execute()
  - clearFilter
```
public void clearFilter()
```
    Clear the filter
    
    Returns:
    BBjString the js code used to clear the filter
  - execute
```
public BBjString execute(BBjNumber send!)
```
    Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set.
    
    Parameters:
    BBjNumber send! when true the execution code will executed on the client , false otherwise
    Returns:
    BBjString The generated js code used to execute the model on the client
    Throws:
    256 when the column or the widget are not defined
  - execute
```
public BBjString execute()
```
    Tell the grid to refresh rows based on the filter. the filter does not do this automatically in case multiple filters are going to get set.
    
    Parameters:
    BBjNumber send! when true the execution code will executed on the client , false otherwise
    Throws:
    256 when the column or the widget are not defined
  - getAsJsonObject
```
public JsonObject getAsJsonObject()
```
    Convert the model to JSON object
    
    Returns:
    JsonObject
  - getColumn
```
public BBjString getColumn()
```
    Get the working column
    
    Returns:
    BBjString
  - getWidget
```
public BBjGridExWidget getWidget()
```
    Get the widget instance
    
    Returns:
    BBjGridExWidget
  - isFilterActive
```
public BBjNumber isFilterActive()
```
    Check if the filter is action or not
    
    #API
    
    Returns:
    BBjNumber true when action , false otherwise
    Throws:
    256 when the column or the widget are not defined
  - setColumn
```
public void setColumn(BBjString column!)
```
    Set the working column
    
    Parameters:
    BBjString column! the column id
  - setWidget
```
public void setWidget(BBjGridExWidget widget!)
```
    Set the widget instance
    
    Parameters:
    BBjGridExWidget widget!
  - supportsCombinedModel
```
public BBjNumber supportsCombinedModel()
```
    Check if the filter supported the combined model
    
    Returns:
    BBjNumber true when the filter support combined model , false otherwise
  - update
```
public BBjString update()
```
    Update the filter on the client and execute it.
    
    Returns:
    BBjString the js code used
    Throws:
    256 when the column or the widget are not defined

Interface GxClientFilterModel

Method Summary

Method Detail

apply

apply

clearFilter

execute

execute

getAsJsonObject

getColumn

getWidget

isFilterActive

setColumn

setWidget

supportsCombinedModel

update